VIVE 3DSP Native C Library  ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
Related Functions
vive_3dsp_context Struct Reference

The vive_3dsp_context structure represents the overall audio engine of 3D sound model. More...

#include <vive_3dsp_api/vive_3dsp_api.h>

Related Functions

(Note that these are not member functions.)

VIVE_3DSP_API_STATUS vive_3dsp_audiofx_get_version (VIVE_3DSP_Version *ver)
 
VIVE_3DSP_API_STATUS vive_3dsp_get_version (VIVE_3DSP_Version *ver)
 
VIVE_3DSP_API_STATUS vive_3dsp_listener_set_position (vive_3dsp_context *api, VIVE_3DSP_Vector3 pos)
 
VIVE_3DSP_API_STATUS vive_3dsp_listener_set_rotation_euler (vive_3dsp_context *api, VIVE_3DSP_Vector3 euler)
 
VIVE_3DSP_API_STATUS vive_3dsp_listener_set_rotation (vive_3dsp_context *api, VIVE_3DSP_Quaternion quat)
 
VIVE_3DSP_API_STATUS vive_3dsp_listener_set_gain (vive_3dsp_context *api, float gain)
 
VIVE_3DSP_API_STATUS vive_3dsp_listener_set_headset (vive_3dsp_context *api, VIVE_3DSP_HEADSET_MODEL headset)
 
VIVE_3DSP_API_STATUS vive_3dsp_audio_create (vive_3dsp_context **api)
 
VIVE_3DSP_API_STATUS vive_3dsp_audio_destroy (vive_3dsp_context **api)
 

Detailed Description

The vive_3dsp_context structure represents the overall audio engine of 3D sound model.

Examples:
Example.cpp.

Friends And Related Function Documentation

◆ vive_3dsp_audio_create()

VIVE_3DSP_API_STATUS vive_3dsp_audio_create ( vive_3dsp_context **  api)
related

Create audio engine object for HTC Vive 3D signal processing. Call this function to get the audio engine object and use it as a key to call other APIs. Free this object using vive_3dsp_audio_destroy to shut down the audio engine.

Parameters
api[out] The reference of audio engine object.

◆ vive_3dsp_audio_destroy()

VIVE_3DSP_API_STATUS vive_3dsp_audio_destroy ( vive_3dsp_context **  api)
related

Destroy the audio engine object.

Parameters
api[out] The reference of audio engine object. This argument is going to be assigned a null pointer.

◆ vive_3dsp_audiofx_get_version()

VIVE_3DSP_API_STATUS vive_3dsp_audiofx_get_version ( VIVE_3DSP_Version *  ver)
related

Get version information of the audio effect library.

Parameters
verVersion.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_get_version()

VIVE_3DSP_API_STATUS vive_3dsp_get_version ( VIVE_3DSP_Version *  ver)
related

Get version information of this SDK.

Parameters
verVersion.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_listener_set_gain()

VIVE_3DSP_API_STATUS vive_3dsp_listener_set_gain ( vive_3dsp_context *  api,
float  gain 
)
related

Set output gain of the audio listener.

Parameters
apiThe audio engine object.
gainOutput gain. It should be nonnegative and in linear scale.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_listener_set_headset()

VIVE_3DSP_API_STATUS vive_3dsp_listener_set_headset ( vive_3dsp_context *  api,
VIVE_3DSP_HEADSET_MODEL  headset 
)
related

Invoke this function when the listener leaves the room.

Parameters
apiThe audio engine object.
headsetSupported headset model. Please refer to VIVE_3DSP_HEADSET_MODEL.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_listener_set_position()

VIVE_3DSP_API_STATUS vive_3dsp_listener_set_position ( vive_3dsp_context *  api,
VIVE_3DSP_Vector3  pos 
)
related

Set the position of the audio listener.

Parameters
apiThe audio engine object.
posThe 3D position of the audio listener.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_listener_set_rotation()

VIVE_3DSP_API_STATUS vive_3dsp_listener_set_rotation ( vive_3dsp_context *  api,
VIVE_3DSP_Quaternion  quat 
)
related

Update the rotation of the audio listener.

Parameters
apiThe audio engine object.
quatQuaternion representation of listener's rotation.
Returns
Status code indicating whether or not the operation succeeded.

◆ vive_3dsp_listener_set_rotation_euler()

VIVE_3DSP_API_STATUS vive_3dsp_listener_set_rotation_euler ( vive_3dsp_context *  api,
VIVE_3DSP_Vector3  euler 
)
related

Update the rotation of the audio listener.

Parameters
apiThe audio engine object.
eulerThe Euler angles of listener's rotation. The parameters (x, y, z) stand for (roll, pitch, yaw). They are expressed in radius.
Returns
Status code indicating whether or not the operation succeeded.

The documentation for this struct was generated from the following files: